---
title: "SSH"
sidebarTitle: "SSH Provider"
description: "The `SSH Provider` is a provider that provides a way to execute SSH commands and get their output."
---

## Inputs

- command [**mandatory**]: The command to be executed
- \*\*kwargs [**optional**]: Extra parameters to be formatted in the command (can be other steps output for example)

## Outputs

List of lines read from the remote SSH server, both the **stdout** and the **stderr**

## Authentication Parameters

This section describes the authentication configuration required for the `SshProvider`. The authentication configuration includes the following fields:

- `host`: The hostname of the SSH server.
- `user`: The username to use for the SSH connection.
- `port`: The port to use for the SSH connection. Defaults to 22.
- `pkey`: The private key to use for the SSH connection. If provided, the connection will be established using this private key instead of a password.
- `password`: The password to use for the SSH connection. If the private key is not provided, the connection will be established using this password.

## Connecting with the Provider

The `SshProvider` class provides a way to execute SSH commands and get their output. The class uses the `paramiko` library to establish an SSH connection to a server and execute commands.

## Notes

_No information yet, feel free to contribute it using the "Edit this page" link the buttom of the page_

## Useful Links

- https://www.ssh.com/academy/ssh/keygen
